楽天ペイV2決済 API一覧

HTTP仕様(.idPass)

HTTP仕様(.json)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200:正常時
  • 400:入力パラメータエラー、加盟店設定エラー
  • 500:システムエラー
  • 502:決済エラー
       
    ※以下のエラーコードはhttp200で返却される可能性がございます。
      ・E90010001
      ・E92000001
      ・E92000002
      ・E91099996
      ・E91099997

EntryTranRakutenpay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

JobCd jobCd 必須
処理区分

AUTH:仮売上
CAPTURE:即時売上

Amount amount 必須 半角数字7桁
利用金額

Tax tax 半角数字7桁
税送料

URL
/payment/EntryTranRakutenpay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "orderID": "ORDER0000001",
    "jobCd": "AUTH",
    "amount": "1000",
    "tax": "100"
 }
URL
/payment/EntryTranRakutenpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000&Tax=100
レスポンス
正常
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517"
}
レスポンスパラメータ:正常系
AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517
レスポンスパラメータ:異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranRakutenpay 決済実行

これ以降の決済取引で必要となるトークンと遷移URLを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を設定します。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1
ClientField2 clientField2 全半角100バイト
加盟店自由項目2
ClientField3 clientField3 全半角100バイト
加盟店自由項目3
RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
楽天ペイ決済上でお客様が決済手続きを正常に完了された場合に、指定されたURLに結果をリダイレクト経由で送信されます。

PaymentTermSec paymentTermSec 半角数字4桁
支払開始期限秒

未指定の場合は120が設定されます。
最大は1800(30分)です。

RetryCount retryCount 半角数字1桁
決済リトライ可能回数

決済が失敗した際、お客様がクレジットカードを選び直し決済をリトライできる最大回数を設定します。ユーザー離脱防止のため、3〜5回を推奨しております。未指定の場合は3が設定されます。

Description description 全半角300桁
楽天説明文

楽天ペイ管理画面で表示される説明文です。
全半角を含めて300文字まで入力が可能です。

不正注文対策として以下指定のフォーマットにて設定してください。
・購入商品の商品情報(一部でも可)を設定してください 。
・購入商品の特定ができない名称は避けてください。
・購入商品が複数の場合、セミコロン「;」区切りでご記載ください。
※型番商品の場合ブランド名の併記を推奨します。
※個人情報(氏名・住所等)を設定しないでください。
※上記は変更される可能性があります。詳細は楽天レギュレーションをご参照ください。

URL
/payment/ExecTranRakutenpay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517",
    "orderID": "ORDER0000001",
    "retURL": "https://example.com/receive/success"
}
URL
/payment/ExecTranRakutenpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&RetURL=https://example.com/receive/success
レスポンス
正常
AccessID accessID 必須 半角英数32桁 固定
取引ID
Token token 必須 半角英数記号256桁 固定
トークン

取引IDのハッシュ値を返却します。

StartURL startURL 必須 半角英数記号256桁
支払手続き開始IFのURL

支払手続き開始IFのURLを返却します。

StartLimitDate startLimitDate 必須 半角数字14桁 固定
支払開始期限日時

yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "token": "wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F",
    "startURL": "https://x01.mul-pay.jp/payment/RakutenpayStart.idPass",
    "startLimitDate": "20210501000000"
}
レスポンスパラメータ:正常系
AccessID=467d50a6bc03dabe1713f8d49042bd96&Token=wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F&StartURL=https://x01.mul-pay.jp/payment/RakutenpayStart.idPass&StartLimitDate=20210501000000
レスポンスパラメータ:異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

RakutenpayStart 支払手続き開始IFの呼び出し

楽天ペイ(オンライン決済)V2において、お客様を楽天ペイの認証画面へと遷移させる必要があります。 加盟店様はリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。 当サービスは各種パラメータを設定し、お客様を楽天ペイの認証画面に誘導します。 ※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

Token 必須 半角英数256桁 固定
トークン

【決済実行】で発行された値を設定します。

URL
/payment/RakutenpayStart.idPass
リクエストパラメータ
AccessID=467d50a6bc03dabe1713f8d49042bd96&Token=wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="RakutenpayStartCall" action="{RakutenpayStartURL}" method="POST">
    <noscript>
      <center>
        <h2>楽天ペイの決済画面へ遷移します。</h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.RakutenpayStartCall.submit();
      }
    //-->
    </script>
  </body>
</html>
            

決済結果受信

当サービスはお客様が支払操作を完了または中止した際に、【決済実行】で指定した決済結果戻しURLに決済結果を通知します。
ブラウザを×ボタンで閉じた場合など、ユーザの操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にてご確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID 必須 半角英数13桁
ショップID
OrderID 必須 半角英数記号27桁
オーダーID
Status 必須
現状態

処理成功時
・AUTH
・CAPTURE
処理失敗時
・PAYFAIL

TranDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

RakutenChargeID 必須 半角英数記号32桁
楽天チャージID

CheckString 必須
改ざんチェック文字列

OrderID,AccessID,ShopID,ShopPass,RakutenChargeID,Statusを連結しSHA256のハッシュ値を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20210415110000&RakutenChargeID=11111111111111111111111111111111&CheckString=123fe4567ce89e8a0fc12e34567e14bda475561c469c99dc1dc3c4fec9089438
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

RakutenpayCancelReturn キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

取引の利用金額と一致しない場合エラーとなります。

CancelTax cancelTax 半角数字7桁
キャンセル税送料

取引の税送料と一致しない場合エラーとなります。

URL
/payment/RakutenpayCancelReturn.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517",
    "orderID": "ORDER0000001",
    "cancelAmount": "1000",
    "cancelTax": "0"
}
URL
/payment/RakutenpayCancelReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&CancelAmount=1000&CancelTax=0
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

Status status 必須
現状態

キャンセル・返品成功時
CANCEL:キャンセル
RETURN:返品

Amount amount 必須 半角数字7桁
利用金額

キャンセル・返品成功時は0を返却します。

Tax tax 必須 半角数字7桁
税送料

キャンセル・返品成功時は0を返却します。

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

リクエストしたキャンセル・返品金額を返却します。

CancelTax cancelTax 必須 半角数字7桁
キャンセル税送料

リクエストしたキャンセル・返品税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
    "orderID": "ORDER0000001",
    "status": "CANCEL",
    "amount": "0",
    "tax": "0",
    "cancelAmount": "1000",
    "cancelTax": "10"
}
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=10
レスポンスパラメータ:異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

RakutenpaySales 実売上

仮売上の決済に対して実売上を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字7桁
利用金額

取引の利用金額と一致しない場合エラーとなります。

Tax tax 半角数字7桁
税送料

取引の税送料と一致しない場合エラーとなります。

URL
/payment/RakutenpaySales.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517",
    "orderID": "ORDER0000001",
    "amount": "1000",
    "tax": "0"
}
URL
/payment/RakutenpaySales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&Amount=1000&Tax=0
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID
Status status 必須
現状態

売上確定成功時
・SALES:実売上
売上確定失敗時
・AUTH:仮売上

Amount amount 必須 半角数字7桁
利用金額
Tax tax 必須 半角数字7桁
税送料
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "100"
}
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=100
レスポンスパラメータ:異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

RakutenpayChange 金額変更

仮売上・即時売上・実売上の取引に対して金額変更を行います。仮売上の取引は仮売上時と同額を指定することで、仮売上有効期限の延長(再オーソリ)を行うことができます。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字7桁
変更後金額

変更後金額 + 変更後税送料が処理金額となります。

Tax tax 半角数字7桁
変更後税送料

変更後金額 + 変更後税送料が処理金額となります。

URL
/payment/RakutenpayChange.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "467d50a6bc03dabe1713f8d49042bd96",
    "accessPass": "bfa37e690fdcc229b2c5185228ace517",
    "orderID": "ORDER0000001",
    "amount": "1100",
    "tax": "0"
}
URL
/payment/RakutenpayChange.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=467d50a6bc03dabe1713f8d49042bd96&AccessPass=bfa37e690fdcc229b2c5185228ace517&OrderID=ORDER0000001&Amount=1100&Tax=0
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID
Status status 必須
現状態

金額変更処理前のステータスが返却されます。

Amount amount 必須 半角数字7桁
変更後利用金額

金額変更した利用金額を返却します。

Tax tax 必須 半角数字7桁
変更後税送料

金額変更した税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "100"
}
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=100
レスポンスパラメータ:異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeRakutenpay 取引状態参照

対象取引の取引状態を取得します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

PayType payType 半角数字2桁
決済方法

SearchTradeMultiをご利用の際は「50」を指定してください。

URL
/payment/SearchTradeRakutenpay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "orderID": "ORDER0000001"
}
URL
/payment/SearchTradeRakutenpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=50
レスポンス
正常
Status status 必須
現状態

UNPROCESSED:未決済
REQSUCCESS:要求成功
AUTHPROCESS:認証処理中
PAYFAIL:決済失敗
AUTH:仮売上
SALES:実売上
CAPTURE:即時売上
CANCEL:キャンセル
RETURN:返品
EXPIRED:期限切れ

ProcessDate processDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

JobCd jobCd 必須
処理区分

AUTH:仮売上
CAPTURE:即時売上
SALES:実売上
CANCEL:キャンセル
RETURN:返品
CHANGE:金額変更

AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
Amount amount 必須 半角数字7桁
利用金額
Tax tax 必須 半角数字7桁
税送料
ClientField1 clientField1 必須 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 必須 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 必須 全半角100バイト
加盟店自由項目3

PayType payType 必須 半角数字2桁
決済方法

50:楽天ペイ(オンライン決済)V2

RakutenChargeID rakutenChargeID 半角英数32桁
楽天チャージID
ReauthLimitDate reauthLimitDate 半角数字14桁 固定
仮売上有効期限延長期限

yyyyMMddHHmmss書式

SalesLimitDate salesLimitDate 半角数字14桁 固定
実売上期限

yyyyMMddHHmmss書式

ChangeLimitDate changeLimitDate 半角数字14桁 固定
金額変更期限

yyyyMMddHHmmss書式

CancelLimitDate cancelLimitDate 半角数字14桁 固定
キャンセル期限

yyyyMMddHHmmss書式

RakutenPoint rakutenPoint 半角数字7桁
楽天ペイで使用されたポイント
RakutenSubscriptionType rakutenSubscriptionType 半角英字10桁
サブスクリプションタイプ

都度決済の場合は値を返却しません。

RakutenSubscriptionID rakutenSubscriptionID 半角英数15桁
サブスクリプションID

都度決済の場合は値を返却しません。

RakutenSettlementSubscriptionID rakutenSettlementSubscriptionID 半角英数15桁
随時決済時に用いたサブスクリプションID

都度決済の場合は値を返却しません。

RakutenSubscriptionCurrentStatus rakutenSubscriptionCurrentStatus
サブスクリプション現状態

都度決済の場合は値を返却しません。

RakutenSubscriptionStartDate rakutenSubscriptionStartDate 半角数字14桁 固定
利用承諾日付

都度決済の場合は値を返却しません。

RakutenSubscriptionAmount rakutenSubscriptionAmount 半角数字7桁
利用承諾金額

都度決済の場合は値を返却しません。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
{
    "status": "SALES",
    "processDate": "20210308125035",
    "jobCd": "SALES",
    "accessID": "2bb0da27c4cf3e95b810509bb4541397",
    "accessPass": "fb8f3d9c7408e8eb47448010d356cd58",
    "amount": "1000",
    "tax": "100",
    "clientField1": "",
    "clientField2": "",
    "clientField3": "",
    "payType": "50",
    "rakutenChargeID": "ch_67XXXXXXX8M",
    "reauthLimitDate": "20210308125035",
    "salesLimitDate": "20210308125035",
    "changeLimitDate": "20210308125035",
    "cancelLimitDate": "20210308125035",
    "rakutenPoint": "0",
    "rakutenSubscriptionType": "",
    "rakutenSubscriptionID": "",
    "rakutenSettlementSubscriptionID": "",
    "rakutenSubscriptionCurrentStatus": "",
    "rakutenSubscriptionStartDate": "",
    "rakutenSubscriptionAmount": ""
}
レスポンスパラメータ:正常系
Status=SALES&ProcessDate=20210308125035&JobCd=SALES&AccessID=2bb0da27c4cf3e95b810509bb4541397&AccessPass=fb8f3d9c7408e8eb47448010d356cd58&Amount=1000&Tax=100&ClientField1=&ClientField2=&ClientField3=&PayType=50&RakutenChargeID=ch_67XXXXXXX8M&ReauthLimitDate=20210308125035&SalesLimitDate=20210308125035&ChangeLimitDate=20210308125035&CancelLimitDate=20210308125035&RakutenPoint=0&RakutenSubscriptionType=&RakutenSubscriptionID=&RakutenSettlementSubscriptionID=&RakutenSubscriptionCurrentStatus=&RakutenSubscriptionStartDate=&RakutenSubscriptionAmount=
レスポンスパラメータ:異常系
[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001